<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: Spec::Runner::Formatter::BaseFormatter</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">Spec::Runner::Formatter::BaseFormatter</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../../../files/vendor\plugins\rspec/lib/spec/runner/formatter/base_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/base_formatter.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                <a href="../../../Object.html">
                Object
               </a>
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
Baseclass for formatters that implements all required methods as no-ops.
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000237">add_behaviour</a>&nbsp;&nbsp;
      <a href="#M000246">close</a>&nbsp;&nbsp;
      <a href="#M000243">dump_failure</a>&nbsp;&nbsp;
      <a href="#M000245">dump_pending</a>&nbsp;&nbsp;
      <a href="#M000244">dump_summary</a>&nbsp;&nbsp;
      <a href="#M000240">example_failed</a>&nbsp;&nbsp;
      <a href="#M000239">example_passed</a>&nbsp;&nbsp;
      <a href="#M000241">example_pending</a>&nbsp;&nbsp;
      <a href="#M000238">example_started</a>&nbsp;&nbsp;
      <a href="#M000235">new</a>&nbsp;&nbsp;
      <a href="#M000236">start</a>&nbsp;&nbsp;
      <a href="#M000242">start_dump</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">





      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000235" class="method-detail">
        <a name="M000235"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000235.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000235.html');return false;">
          <span class="method-name">new</span><span class="method-args">(where)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000237" class="method-detail">
        <a name="M000237"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000237.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000237.html');return false;">
          <span class="method-name">add_behaviour</span><span class="method-args">(name)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked at the beginning of the execution of each behaviour.
<tt>name</tt> is the name of the behaviour and <tt>first</tt> is true if it
is the first behaviour - otherwise it&#8216;s false.
</p>
<p>
The next method to be invoked after this is <a
href="BaseFormatter.html#M000240">example_failed</a> or example_finished
</p>
        </div>
      </div>

      <div id="method-M000246" class="method-detail">
        <a name="M000246"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000246.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000246.html');return false;">
          <span class="method-name">close</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked at the very end. Allows the formatter to clean up,
like closing open streams.
</p>
        </div>
      </div>

      <div id="method-M000243" class="method-detail">
        <a name="M000243"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000243.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000243.html');return false;">
          <span class="method-name">dump_failure</span><span class="method-args">(counter, failure)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Dumps detailed information about an example failure. This method is invoked
for each failed example after all examples have run. <tt>counter</tt> is
the sequence number of the associated example. <tt>failure</tt> is a
Failure object, which contains detailed information about the failure.
</p>
        </div>
      </div>

      <div id="method-M000245" class="method-detail">
        <a name="M000245"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000245.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000245.html');return false;">
          <span class="method-name">dump_pending</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This gets invoked after the summary if option is set to do so.
</p>
        </div>
      </div>

      <div id="method-M000244" class="method-detail">
        <a name="M000244"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000244.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000244.html');return false;">
          <span class="method-name">dump_summary</span><span class="method-args">(duration, example_count, failure_count, pending_count)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked after the dumping of examples and failures.
</p>
        </div>
      </div>

      <div id="method-M000240" class="method-detail">
        <a name="M000240"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000240.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000240.html');return false;">
          <span class="method-name">example_failed</span><span class="method-args">(example, counter, failure)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked when an <tt>example</tt> fails, i.e. an exception
occurred inside it (such as a failed should or other exception).
<tt>counter</tt> is the sequence number of the failure (starting at 1) and
<tt>failure</tt> is the associated Failure object.
</p>
        </div>
      </div>

      <div id="method-M000239" class="method-detail">
        <a name="M000239"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000239.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000239.html');return false;">
          <span class="method-name">example_passed</span><span class="method-args">(example)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked when an <tt>example</tt> passes.
</p>
        </div>
      </div>

      <div id="method-M000241" class="method-detail">
        <a name="M000241"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000241.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000241.html');return false;">
          <span class="method-name">example_pending</span><span class="method-args">(behaviour_name, example_name, message)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked when an example is not yet implemented (i.e. has not
been provided a block), or when an ExamplePendingError is raised.
<tt>name</tt> is the name of the example. <tt>message</tt> is the message
from the ExamplePendingError, if it exists, or the default value of
&quot;Not Yet Implemented&quot;
</p>
        </div>
      </div>

      <div id="method-M000238" class="method-detail">
        <a name="M000238"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000238.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000238.html');return false;">
          <span class="method-name">example_started</span><span class="method-args">(example)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked when an <tt>example</tt> starts.
</p>
        </div>
      </div>

      <div id="method-M000236" class="method-detail">
        <a name="M000236"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000236.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000236.html');return false;">
          <span class="method-name">start</span><span class="method-args">(example_count)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked before any examples are run, right after they have
all been collected. This can be useful for special formatters that need to
provide progress on feedback (graphical ones)
</p>
<p>
This method will only be invoked once, and the next one to be invoked is <a
href="BaseFormatter.html#M000237">add_behaviour</a>
</p>
        </div>
      </div>

      <div id="method-M000242" class="method-detail">
        <a name="M000242"></a>

        <div class="method-heading">
          <a href="BaseFormatter.src/M000242.html" target="Code" class="method-signature"
            onclick="popupCode('BaseFormatter.src/M000242.html');return false;">
          <span class="method-name">start_dump</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
This method is invoked after all of the examples have executed. The next
method to be invoked after this one is <a
href="BaseFormatter.html#M000243">dump_failure</a> (once for each failed
example),
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>